<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstRtphdrext: GStreamer Base Plugins 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-rtp.html" title="RTP Library">
<link rel="prev" href="gst-plugins-base-libs-GstRTPPayloadInfo.html" title="GstRTPPayloadInfo">
<link rel="next" href="gst-plugins-base-libs-GstRTPdefs.html" title="GstRTPdefs">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-base-libs-GstRtphdrext.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gstreamer-rtp.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-base-libs-GstRTPPayloadInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-base-libs-GstRTPdefs.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-base-libs-GstRtphdrext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-GstRtphdrext.top_of_page"></a>GstRtphdrext</span></h2>
<p>GstRtphdrext — Helper methods for dealing with RTP header extensions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-base-libs-GstRtphdrext.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-get-ntp-56" title="gst_rtp_hdrext_get_ntp_56 ()">gst_rtp_hdrext_get_ntp_56</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-get-ntp-64" title="gst_rtp_hdrext_get_ntp_64 ()">gst_rtp_hdrext_get_ntp_64</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-set-ntp-56" title="gst_rtp_hdrext_set_ntp_56 ()">gst_rtp_hdrext_set_ntp_56</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-set-ntp-64" title="gst_rtp_hdrext_set_ntp_64 ()">gst_rtp_hdrext_set_ntp_64</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-GstRtphdrext.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-BASE:CAPS" title="GST_RTP_HDREXT_BASE">GST_RTP_HDREXT_BASE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-56:CAPS" title="GST_RTP_HDREXT_NTP_56">GST_RTP_HDREXT_NTP_56</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-56-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_56_SIZE">GST_RTP_HDREXT_NTP_56_SIZE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-64:CAPS" title="GST_RTP_HDREXT_NTP_64">GST_RTP_HDREXT_NTP_64</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-64-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_64_SIZE">GST_RTP_HDREXT_NTP_64_SIZE</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-GstRtphdrext.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gst/rtp/rtp.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-GstRtphdrext.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-GstRtphdrext.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-rtp-hdrext-get-ntp-56"></a><h3>gst_rtp_hdrext_get_ntp_56 ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_rtp_hdrext_get_ntp_56 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *ntptime</code></em>);</pre>
<p>Reads the NTP time from the <em class="parameter"><code>size</code></em>
 NTP-56 extension bytes in <em class="parameter"><code>data</code></em>
 and store the
result in <em class="parameter"><code>ntptime</code></em>
.</p>
<div class="refsect3">
<a name="gst-rtp-hdrext-get-ntp-56.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>the data to read from. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ntptime</p></td>
<td class="parameter_description"><p>the result NTP time. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtp-hdrext-get-ntp-56.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-hdrext-get-ntp-64"></a><h3>gst_rtp_hdrext_get_ntp_64 ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_rtp_hdrext_get_ntp_64 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *ntptime</code></em>);</pre>
<p>Reads the NTP time from the <em class="parameter"><code>size</code></em>
 NTP-64 extension bytes in <em class="parameter"><code>data</code></em>
 and store the
result in <em class="parameter"><code>ntptime</code></em>
.</p>
<div class="refsect3">
<a name="gst-rtp-hdrext-get-ntp-64.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>the data to read from. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ntptime</p></td>
<td class="parameter_description"><p>the result NTP time. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtp-hdrext-get-ntp-64.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-hdrext-set-ntp-56"></a><h3>gst_rtp_hdrext_set_ntp_56 ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_rtp_hdrext_set_ntp_56 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> ntptime</code></em>);</pre>
<p>Writes the NTP time in <em class="parameter"><code>ntptime</code></em>
 to the format required for the NTP-56 header
extension. <em class="parameter"><code>data</code></em>
 must hold at least <a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-56-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_56_SIZE"><span class="type">GST_RTP_HDREXT_NTP_56_SIZE</span></a> bytes.</p>
<div class="refsect3">
<a name="gst-rtp-hdrext-set-ntp-56.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>the data to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ntptime</p></td>
<td class="parameter_description"><p>the NTP time</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtp-hdrext-set-ntp-56.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-hdrext-set-ntp-64"></a><h3>gst_rtp_hdrext_set_ntp_64 ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_rtp_hdrext_set_ntp_64 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> ntptime</code></em>);</pre>
<p>Writes the NTP time in <em class="parameter"><code>ntptime</code></em>
 to the format required for the NTP-64 header
extension. <em class="parameter"><code>data</code></em>
 must hold at least <a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-64-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_64_SIZE"><span class="type">GST_RTP_HDREXT_NTP_64_SIZE</span></a> bytes.</p>
<div class="refsect3">
<a name="gst-rtp-hdrext-set-ntp-64.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>the data to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ntptime</p></td>
<td class="parameter_description"><p>the NTP time</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtp-hdrext-set-ntp-64.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-GstRtphdrext.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GST-RTP-HDREXT-BASE:CAPS"></a><h3>GST_RTP_HDREXT_BASE</h3>
<pre class="programlisting">#define GST_RTP_HDREXT_BASE "urn:ietf:params:rtp-hdrext:"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GST-RTP-HDREXT-NTP-56:CAPS"></a><h3>GST_RTP_HDREXT_NTP_56</h3>
<pre class="programlisting">#define GST_RTP_HDREXT_NTP_56 "ntp-56"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GST-RTP-HDREXT-NTP-56-SIZE:CAPS"></a><h3>GST_RTP_HDREXT_NTP_56_SIZE</h3>
<pre class="programlisting">#define GST_RTP_HDREXT_NTP_56_SIZE 7
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GST-RTP-HDREXT-NTP-64:CAPS"></a><h3>GST_RTP_HDREXT_NTP_64</h3>
<pre class="programlisting">#define GST_RTP_HDREXT_NTP_64 "ntp-64"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GST-RTP-HDREXT-NTP-64-SIZE:CAPS"></a><h3>GST_RTP_HDREXT_NTP_64_SIZE</h3>
<pre class="programlisting">#define GST_RTP_HDREXT_NTP_64_SIZE 8
</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-GstRtphdrext.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>, <a class="link" href="GstRTPBaseDepayload.html" title="GstRTPBaseDepayload"><span class="type">GstRTPBaseDepayload</span></a>, gstrtpbuffer</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>